Skip to content

docs: doc-review 2026-10-14 — investigation entries, alert-aggregation rework, label panel, dashboard and RUM drift - #1053

Merged
ysyneu merged 2 commits into
mainfrom
doc-review/2026-10-14-081143
Oct 14, 2026
Merged

ysyneu merged 2 commits into
mainfrom
doc-review/2026-10-14-081143

Conversation

@flashduty

@flashduty flashduty Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

Doc Review — 2026-10-14

Mode: diff (since 2026-10-13T08:11:02Z — the previous successful run — through 2026-10-14T08:11Z)
Findings: 42 total — 3 high, 31 medium, 8 low
Repos scanned: 23 (all source repos in mapping.yaml + the 6 fc-foundation-app submodule repos, cloned as siblings)
Branch: doc-review/2026-10-14-081143

Changes

Finding Type Module Doc Action
f220 missing_coverage monitors monitors/quickstart/quickstart.mdx edited zh + en
f120 feature_drift on-call on-call/channel/create-edit.mdx edited zh + en
f140 missing_coverage on-call on-call/incident/search-view-incident.mdx edited zh + en
f501 stale_content ai-sre ai-sre/im.mdx edited zh + en
f601 missing_coverage derivative changelog/changelog.mdx edited zh + en
f602 missing_coverage derivative changelog/changelog.mdx edited zh + en
f603 missing_coverage derivative changelog/changelog.mdx edited zh + en
f604 missing_coverage derivative changelog/changelog.mdx edited zh + en
f605 missing_coverage derivative changelog/changelog.mdx edited zh + en
f201 feature_drift monitors monitors/dashboards/dashboards.mdx edited zh + en
f202 feature_drift monitors monitors/dashboards/dashboards.mdx edited zh + en
f203 missing_coverage monitors monitors/dashboards/dashboards.mdx edited zh + en
f240 feature_drift monitors monitors/explore/explore.mdx edited zh + en
f241 feature_drift monitors monitors/explore/explore.mdx edited zh + en
f221 feature_drift monitors monitors/alert-rules/active-alerts.mdx edited zh + en
f121 feature_drift on-call on-call/channel/noise-reduction.mdx edited zh + en
f122 config_drift on-call on-call/channel/noise-reduction.mdx edited zh + en
f101 missing_coverage on-call on-call/channel/noise-reduction.mdx edited zh + en
f102 config_drift on-call on-call/channel/noise-reduction.mdx edited zh + en
f103 config_drift on-call on-call/channel/noise-reduction.mdx edited zh + en
f107 config_drift on-call on-call/channel/noise-reduction.mdx edited zh + en
f141 feature_drift on-call on-call/incident/what-is-incident.mdx edited zh + en
f142 stale_content on-call on-call/incident/search-view-incident.mdx edited zh + en
f143 missing_coverage on-call on-call/incident/what-is-incident.mdx edited zh + en
f160 feature_drift on-call on-call/configuration/schedule.mdx edited zh + en
f161 feature_drift on-call on-call/incident/alert-management.mdx edited zh + en
f401 config_drift platform platform/team-members.mdx edited zh + en
f301 config_drift rum rum/quickstart/app-management.mdx edited zh + en
f204 config_drift monitors monitors/dashboards/dashboards.mdx edited zh + en
f242 config_drift monitors monitors/explore/explore.mdx edited zh + en
f222 config_drift go-sdk developer/go-sdk.mdx edited zh + en
f123 stale_content on-call/integration on-call/integration/alert-integration/routing-rules.mdx edited zh + en
f104 config_drift on-call on-call/channel/noise-reduction.mdx edited zh + en
f105 missing_coverage on-call on-call/channel/noise-reduction.mdx edited zh + en
f106 stale_content on-call on-call/channel/noise-reduction.mdx edited zh + en
f302 missing_coverage rum rum/sdk/harmony/advanced-config.mdx edited zh + en

Also in this PR:

Item Doc Action
changelog entry for the window's features changelog/changelog.mdx (+ en) new <Update label="2026-10-14"> block with five sections
new page for alert-rule investigation entries monitors/alert-rules/investigation-entries.mdx (NEW, zh + en) written from source; registered in docs.json in both language trees
License-release cap applies to both license types platform/pricing.mdx (+ en) moved the cap out of the 「临时 License」 tab into a type-agnostic Note

Review checklist

  • Verify config field names and defaults match current code
  • Check that feature descriptions accurately reflect user-facing behavior
  • Ensure tone and style match the rest of the docs
  • The new monitors/alert-rules/investigation-entries page is the biggest addition — review it first
  • mint broken-links (Mintlify v20 runtime): success no broken links found

Cross-repo follow-ups (flashduty-website)

Five derivative findings target the website repo. Per the automation's rules they are not edited here;
each needs a website changelog entry (the site's content/changelog/ stops at 2026-10-05):

  • content/changelog/2026-10-14-investigation-entries.mdx (+ .zh.mdx) — the investigation-entries capability (rule-side 调查入口 → detail-side 排查入口).
  • content/changelog/2026-10-14-alert-aggregation-methods.mdx (+ .zh.mdx) — the three mutually-exclusive grouping methods and the new 告警聚合 wizard step.
  • content/changelog/2026-10-14-incident-label-panel.mdx (+ .zh.mdx) — the label-panel rework (系统标签, 相关链接 bar, richer value rendering, 去查询 icon removed).
  • content/changelog/2026-10-14-schedule-notify-cycles.mdx (+ .zh.mdx) — 定时通知 gained 每天 / 每周 / 每月 cycles.
  • content/changelog/2026-10-14-dashboard-global-search.mdx (+ .zh.mdx) — dashboard global search and the panel-editor changes.

Website integrations catalog: no follow-up — no window feature is an alert-source/tool integration and no integration-count claim drifted.

Corrections made during review (worth a second pair of eyes)

  • License-release cap scope. The cap bullet in platform/pricing.mdx sat inside the 「临时 License」 tab while enforcement counts releases per account regardless of license type (fc-event logic/resource/usage.go:102,644 = LicenseCnt × 10 per window; member removal bypasses it — cmd/server/controller/license/inter.go:86-88). Moved to a type-agnostic <Note> after the tabs; the numeric multiplier is deliberately not published.
  • HarmonyOS SDK version gates. The RUM edits state 0.6.0 for console remote configuration and 0.7.0 for sessionOnError. These were briefly removed during review as unverifiable, then restored: fc-sdk-harmony tag harmony-sdk-v0.6.0 is the first tag containing bbc40cf ("Read the console's sampling settings on HarmonyOS"), and harmony-sdk-v0.7.0 is the first containing cd92a56 ("add sessionOnError …"). That repo is not in mapping.yaml, which is why the first search missed it.
  • Time-range validation wording (f220). The finding said each side must be > 0; the code is before >= 0 && after >= 0 && before + after > 0 (pages/rule/investigation.ts). The new page and the changelog follow the code.

Mapping warnings

  • fc-foundation-app → src/Packages/ai-sre is a gitlink (ai-sre-web); the mapped sub-path src/Packages/ai-sre/src was analyzed from a sibling clone of ai-sre-web.
  • derivative_surfaces.comparison_page.paths points at zh|en/on-call/quickstart/comparison.mdx, which does not exist. The real comparison pages are zh|en/on-call/comparison/vs-pagerduty.mdx and vs-opsgenie.mdx; the derivative pass was run against those, but the registry entry should be corrected in the skill's mapping.yaml.
  • meow-ui (a submodule of fc-foundation-app, 67 changed files this window) is referenced by no module in mapping.yaml, so none of it was analyzed. Shared console code under fc-foundation-app/src/components/** (TimeRange picker grew ~1093 lines this window) is likewise unmapped — that is why no finding covers it.
  • monit-webapi changed exactly one file in the window (misc/plan/dashboard/product/requirements.md, internal product-planning text); its paths are mapped, so it was scanned and produced no finding.

Skipped

  • f606 — comparison page needs a 排查入口 row. Not applied: a new row requires a competitor-side cell, and PagerDuty / Opsgenie capabilities cannot be drafted from our code. Drafted Flashduty-side cell for a human to complete: | **排查入口** | 告警规则可预置仪表盘 / 查询工作台入口(含变量与时间范围),故障与告警详情按触发时的快照一键直达观测 | … | — apply to the §Response table of zh|en/on-call/comparison/vs-pagerduty.mdx and vs-opsgenie.mdx once the competitor cells are confirmed against public sources.
  • f607–f611 — see Cross-repo follow-ups above.
  • api-reference hand-off (not a finding in this run): LicenseListResponse in api-reference/on-call.openapi.{{zh,en}}.json documents only total + items and now lacks the new release_limited field (fc-foundation-app/src/pages/Access/service.ts:21-25). This is api-review's surface, so it was left to that automation rather than hand-edited here.

Known conflicts with open PRs

flashduty[bot] added 2 commits October 14, 2026 08:37
…n rework, label panel, dashboard and RUM remote-config drift

Window: 2026-10-13T08:11:02Z .. 2026-10-14T08:11Z (diff mode, 23 repos scanned).
42 findings (3 high / 31 medium / 8 low); 37 pages edited (zh + en), 1 new page
(monitors/alert-rules/investigation-entries) registered in docs.json.
…icense types; restore source-verified HarmonyOS SDK version gates

- platform/pricing: the per-period release cap applies to releasing a fixed or a
  temporary License (enforced per account in fc-event logic/resource/usage.go), so
  move it out of the 临时 License tab into a type-agnostic Note.
- rum: keep the HarmonyOS remote-config / sessionOnError version gates (0.6.0 /
  0.7.0) — verified against fc-sdk-harmony tags harmony-sdk-v0.6.0 and
  harmony-sdk-v0.7.0.
@ysyneu
ysyneu merged commit de7ff6f into main Oct 14, 2026
2 checks passed
@ysyneu
ysyneu deleted the doc-review/2026-10-14-081143 branch October 14, 2026 08:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant